<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>src.processing.link_indicatorset.Link_indicatorset</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="src-module.html">Package&nbsp;src</a> ::
        <a href="src.processing-module.html">Package&nbsp;processing</a> ::
        <a href="src.processing.link_indicatorset-module.html">Module&nbsp;link_indicatorset</a> ::
        Class&nbsp;Link_indicatorset
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="src.processing.link_indicatorset.Link_indicatorset-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Link_indicatorset</h1><p class="nomargin-top"><span class="codelink"><a href="src.processing.link_indicatorset-pysrc.html#Link_indicatorset">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_src_proc_10" name="uml_class_diagram_for_src_proc_10">
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#indiconf" title="Indicator configuration is a list containing abbreviations of the &#160;indicators or None (means all indicators are in the set)" alt="" coords="64,28,205,47"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#get_indiconf" title="src.processing.indicatorset.Indicatorset.get_indiconf" alt="" coords="64,49,205,68"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#set_indiconf" title="src.processing.indicatorset.Indicatorset.set_indiconf" alt="" coords="64,68,205,87"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#del_indiconf" title="src.processing.indicatorset.Indicatorset.del_indiconf" alt="" coords="64,87,205,105"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#__iter__" title="src.processing.indicatorset.Indicatorset.__iter__" alt="" coords="64,105,205,124"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#next" title="src.processing.indicatorset.Indicatorset.next" alt="" coords="64,124,205,143"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#__getitem__" title="src.processing.indicatorset.Indicatorset.__getitem__" alt="" coords="64,143,205,161"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html#build_indis" title="Adds values to the set depending on the given configuration." alt="" coords="64,161,205,180"/>
<area shape="rect" href="src.processing.indicatorset.Indicatorset-class.html" title="Abstract class which represents a set of indicators." alt="" coords="63,11,207,181"/>
<area shape="rect" href="src.processing.link_indicatorset.Link_indicatorset-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,236,252,255"/>
<area shape="rect" href="src.processing.link_indicatorset.Link_indicatorset-class.html#build_all_indis" title="Add all possible indicators to the set." alt="" coords="17,255,252,273"/>
<area shape="rect" href="src.processing.link_indicatorset.Link_indicatorset-class.html" title="Set of indicators, which may be applied to record_lists containing agg_record&#45;objects from FLEET." alt="" coords="16,211,253,275"/>
</map>
  <img src="uml_class_diagram_for_src_proc_10.gif" alt='' usemap="#uml_class_diagram_for_src_proc_10" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Set of indicators, which may be applied to record_lists containing 
  agg_record-objects from FLEET.</p>
  <p>It uses a reference to the link, so that the indicators can be set up 
  with data from the link, such as aggregated records, timeseries, 
  reference data, length of the link and free flow information. If the 
  indiconf is set None all the indicators will be calculated.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="src.processing.link_indicatorset.Link_indicatorset-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">indiconf</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">link</span>=<span class="summary-sig-default">None</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="src.processing.link_indicatorset-pysrc.html#Link_indicatorset.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="src.processing.link_indicatorset.Link_indicatorset-class.html#build_all_indis" class="summary-sig-name">build_all_indis</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Add all possible indicators to the set.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="src.processing.link_indicatorset-pysrc.html#Link_indicatorset.build_all_indis">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicatorset.Indicatorset-class.html">indicatorset.Indicatorset</a></code></b>:
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#__getitem__">__getitem__</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#__iter__">__iter__</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#build_indis">build_indis</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#del_indiconf">del_indiconf</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#get_indiconf">get_indiconf</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#next">next</a></code>,
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#set_indiconf">set_indiconf</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicatorset.Indicatorset-class.html">indicatorset.Indicatorset</a></code></b> (private):
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#_parse_conf" onclick="show_private();">_parse_conf</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="src.processing.indicatorset.Indicatorset-class.html">indicatorset.Indicatorset</a></code></b>:
      <code><a href="src.processing.indicatorset.Indicatorset-class.html#indiconf">indiconf</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">indiconf</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">link</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="src.processing.link_indicatorset-pysrc.html#Link_indicatorset.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>indiconf</code></strong> - the Indicator-configuration is a list containing the 
          indicators-abbreviations or None (= all indicators, default)</li>
        <li><strong class="pname"><code>link</code></strong> - link for filling indicators</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="build_all_indis"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">build_all_indis</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="src.processing.link_indicatorset-pysrc.html#Link_indicatorset.build_all_indis">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Add all possible indicators to the set.</p>
  <p>The list will contain following indicators:</p>
  <ul>
    <li>
      Buffer (Time) Index
    </li>
    <li>
      Planning Time
    </li>
    <li>
      Planning Speed
    </li>
    <li>
      Buffer Time
    </li>
    <li>
      Buffer Speed
    </li>
    <li>
      Buffer Speed Index
    </li>
    <li>
      Variation of Speeds
    </li>
    <li>
      Planning Time Index
    </li>
    <li>
      Planning Speed Index
    </li>
    <li>
      Mean Squared Error (MSE)
    </li>
    <li>
      Mean Error (ME)
    </li>
    <li>
      Correlation Coefficient
    </li>
    <li>
      Total Mean Error
    </li>
    <li>
      Total Squared Mean Error
    </li>
    <li>
      Total Correlation Coefficient
    </li>
  </ul>
  <dl class="fields">
    <dt>Overrides:
        <a href="src.processing.indicatorset.Indicatorset-class.html#build_all_indis">indicatorset.Indicatorset.build_all_indis</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Oct 25 19:15:42 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
